Update Project

Updates the name and description of an existing project identified by its Pid.

PUT{accelqLoginUrl}/awb/api/2.0/{tenantCode}/administration/projects/{pjPid}

Headers

HeaderValue
user_idLogin username (email)
api_keyAPI key of the user for authentication
Content-Typeapplication/json
Acceptapplication/json

Parameters

ParameterTypeRequiredDescription
accelqLoginUrlstringYesThe AccelQ login URL for API access.
tenantCodestringYesTenant code for identifying the organization.
pjPidintegerYesThe ID of the project to update.
user_idstringYesLogin username (email)
api_keystringYesAPI key of the user for authentication

Request Body

json
{
  "projectName": "Updated Project Name",
  "description": "Updated description"
}

Responses

200 - Project updated successfully.

json
true

409 - Conflict - Project name already exists.

json
{
  "error": "A project with the name 'Updated Project Name' already exists."
}

422 - Project with specified PID not found.

json
{
  "error": "Project with PID 3 not found."
}

cURL Command Builder

URL Parameters

Headers

Request Sample (cURL)

curl -X PUT "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/administration/projects/${{pjPid}}" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "projectName": "Updated Project Name",
  "description": "Updated description"
}'